<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: fsm_change.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsm__change_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fsm_change.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT state change FSM.  
<a href="#details">More...</a></p>

<p><a href="fsm__change_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__fsm__change.html">ec_fsm_change</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">EtherCAT state change FSM.  <a href="structec__fsm__change.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a15cddef62f7f6fa51e07fa06242b7659"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structec__fsm__change.html">ec_fsm_change</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a></td></tr>
<tr class="separator:a15cddef62f7f6fa51e07fa06242b7659"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:afca7005acad1cbd2221d92dfbf4a608b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#afca7005acad1cbd2221d92dfbf4a608b">ec_fsm_change_mode_t</a> { <a class="el" href="fsm__change_8h.html#afca7005acad1cbd2221d92dfbf4a608baab98fc747b7ddcbd70755c03bf31122e">EC_FSM_CHANGE_MODE_FULL</a>, 
<a class="el" href="fsm__change_8h.html#afca7005acad1cbd2221d92dfbf4a608bace4d82f3fb6f59f56e3d4f60a77bb78d">EC_FSM_CHANGE_MODE_ACK_ONLY</a>
 }<tr class="memdesc:afca7005acad1cbd2221d92dfbf4a608b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mode of the change state machine.  <a href="fsm__change_8h.html#afca7005acad1cbd2221d92dfbf4a608b">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:afca7005acad1cbd2221d92dfbf4a608b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9b93c6163e34fd65a4fe44ab28bf5df3"><td class="memItemLeft" align="right" valign="top"><a id="a9b93c6163e34fd65a4fe44ab28bf5df3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a9b93c6163e34fd65a4fe44ab28bf5df3">ec_fsm_change_init</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *, <a class="el" href="structec__datagram__t.html">ec_datagram_t</a> *)</td></tr>
<tr class="memdesc:a9b93c6163e34fd65a4fe44ab28bf5df3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a9b93c6163e34fd65a4fe44ab28bf5df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae14cce5cbfe182e8b7f3b334bcf43abf"><td class="memItemLeft" align="right" valign="top"><a id="ae14cce5cbfe182e8b7f3b334bcf43abf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#ae14cce5cbfe182e8b7f3b334bcf43abf">ec_fsm_change_clear</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *)</td></tr>
<tr class="memdesc:ae14cce5cbfe182e8b7f3b334bcf43abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ae14cce5cbfe182e8b7f3b334bcf43abf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05075c9695464e542905a634ceb071bd"><td class="memItemLeft" align="right" valign="top"><a id="a05075c9695464e542905a634ceb071bd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a05075c9695464e542905a634ceb071bd">ec_fsm_change_start</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *, <a class="el" href="globals_8h.html#a0e9c38c7520909d649fac451046dcde0">ec_slave_state_t</a>)</td></tr>
<tr class="memdesc:a05075c9695464e542905a634ceb071bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the change state machine. <br /></td></tr>
<tr class="separator:a05075c9695464e542905a634ceb071bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c30215c50becd54d3ac1d1ee2b0a96a"><td class="memItemLeft" align="right" valign="top"><a id="a2c30215c50becd54d3ac1d1ee2b0a96a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a2c30215c50becd54d3ac1d1ee2b0a96a">ec_fsm_change_ack</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *)</td></tr>
<tr class="memdesc:a2c30215c50becd54d3ac1d1ee2b0a96a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the change state machine to only acknowlegde a slave's state. <br /></td></tr>
<tr class="separator:a2c30215c50becd54d3ac1d1ee2b0a96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dc0b7823d8a0440797fb93fda8a5b86"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a0dc0b7823d8a0440797fb93fda8a5b86">ec_fsm_change_exec</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *)</td></tr>
<tr class="memdesc:a0dc0b7823d8a0440797fb93fda8a5b86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the current state of the state machine.  <a href="#a0dc0b7823d8a0440797fb93fda8a5b86">More...</a><br /></td></tr>
<tr class="separator:a0dc0b7823d8a0440797fb93fda8a5b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00d02215e861290d5fd7da1d0bc0d64b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__change_8h.html#a00d02215e861290d5fd7da1d0bc0d64b">ec_fsm_change_success</a> (<a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *)</td></tr>
<tr class="memdesc:a00d02215e861290d5fd7da1d0bc0d64b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns, if the state machine terminated with success.  <a href="#a00d02215e861290d5fd7da1d0bc0d64b">More...</a><br /></td></tr>
<tr class="separator:a00d02215e861290d5fd7da1d0bc0d64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT state change FSM. </p>

<p class="definition">Definition in file <a class="el" href="fsm__change_8h_source.html">fsm_change.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a15cddef62f7f6fa51e07fa06242b7659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15cddef62f7f6fa51e07fa06242b7659">&#9670;&nbsp;</a></span>ec_fsm_change_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structec__fsm__change.html">ec_fsm_change</a> <a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structec__fsm__change.html" title="EtherCAT state change FSM. ">ec_fsm_change</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="fsm__change_8h_source.html#l00058">58</a> of file <a class="el" href="fsm__change_8h_source.html">fsm_change.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="afca7005acad1cbd2221d92dfbf4a608b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afca7005acad1cbd2221d92dfbf4a608b">&#9670;&nbsp;</a></span>ec_fsm_change_mode_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fsm__change_8h.html#afca7005acad1cbd2221d92dfbf4a608b">ec_fsm_change_mode_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mode of the change state machine. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afca7005acad1cbd2221d92dfbf4a608baab98fc747b7ddcbd70755c03bf31122e"></a>EC_FSM_CHANGE_MODE_FULL&#160;</td><td class="fielddoc"><p>full state change </p>
</td></tr>
<tr><td class="fieldname"><a id="afca7005acad1cbd2221d92dfbf4a608bace4d82f3fb6f59f56e3d4f60a77bb78d"></a>EC_FSM_CHANGE_MODE_ACK_ONLY&#160;</td><td class="fielddoc"><p>only state acknowledgement </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="fsm__change_8h_source.html#l00050">50</a> of file <a class="el" href="fsm__change_8h_source.html">fsm_change.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0dc0b7823d8a0440797fb93fda8a5b86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dc0b7823d8a0440797fb93fda8a5b86">&#9670;&nbsp;</a></span>ec_fsm_change_exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_change_exec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Executes the current state of the state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if the state machine has terminated </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>finite state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__change_8c_source.html#l00124">124</a> of file <a class="el" href="fsm__change_8c_source.html">fsm_change.c</a>.</p>

</div>
</div>
<a id="a00d02215e861290d5fd7da1d0bc0d64b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d02215e861290d5fd7da1d0bc0d64b">&#9670;&nbsp;</a></span>ec_fsm_change_success()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_change_success </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__change_8h.html#a15cddef62f7f6fa51e07fa06242b7659">ec_fsm_change_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns, if the state machine terminated with success. </p>
<dl class="section return"><dt>Returns</dt><dd>non-zero if successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>Finite state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__change_8c_source.html#l00139">139</a> of file <a class="el" href="fsm__change_8c_source.html">fsm_change.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="fsm__change_8h.html">fsm_change.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
